third-party-exp-api icon

third-party-exp-api

(0 reviews)

Check SSC Payment Status

URLS:

Description : This API is used to get the status of the payment already made to SSC by passing the payNo and bankTransactionId as query parameter. The EXP api will call the backend PRC layer and the process layer will request the SSC SYS layer, SYS layer will call the backend SSC service to verify the payment status.

Channels can consume Mulesoft’s REST API exposed as an experience API.

Mulesoft Request:

Mandatory Headers: client_id, x-channel-id, x-correlation-id, x-bank-id, Authorization

Optional Headers: x-user-id, x-sub-channel-id, x-debug-flag, x-customer-id ,client_secret

URI Parameter

FieldNameDataTypeRequired?LengthsampleDescription
payNoIntegerYesMin 2 Max 501billing number
bankTransactionIdStringYesmin = 4 max = 30ubs123456789Should start with the bank shortname (3 letters example :ubs123456789 , Arb123456789)

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Sample Response

{
  "status": {
    "success": true,
    "code": "200",
    "arabicMessage": "تمت العملية بنجاح",
    "englishMessage": "The Operation has been Successfully Completed"
  },
  "response": {
    "paymentStatus": "0"
  }
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
    "status": {
        "success": false,
        "code": "400",
        "reasonCode": "BadRequest",
        "arabicMessage": "",
        "englishMessage": "No records were found that matched the selection criteria",
        "errorCode": "",
        "backendErrorMessage": ""
    }
}
Below fields should be given back to Channel if x-debug flag = 1

                "errorCode": "",
                "backendErrorMessage": "",

Reviews